AdvanceKeyboardFocus

AdvanceKeyboardFocus
Header:	Controls.h		Carbon status:	Supported

Advances the keyboard focus to the next focusable control in a window.

OSErr AdvanceKeyboardFocus (
    WindowRef inWindow
);

inWindow: A pointer to the window for which to advance keyboard focus.

function result: A result code.

DISCUSSION

The AdvanceKeyboardFocus function skips over deactivated and hidden controls until it finds the next focusable control in the window. If it does not find a focusable item, it simply returns.

When AdvanceKeyboardFocus is called, the Control Manager calls your control definition function and passes kControlMsgFocus in its message parameter and kControlFocusNextPart in its param parameter. In response to this message, your control definition function should change keyboard focus to its next part, the entire control, or remove keyboard focus from the control, depending upon the circumstances. See ControlDefProcPtr for a discussion of possible responses to this message.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.